Update: Add JSDoc documentation for navigation system (fixes #855)#865
Open
joe-replin wants to merge 1 commit into
Open
Update: Add JSDoc documentation for navigation system (fixes #855)#865joe-replin wants to merge 1 commit into
joe-replin wants to merge 1 commit into
Conversation
Add file- and class-level JSDoc, method docs, and small inline descriptions across the navigation subsystem. Updated files: js/models/NavigationButtonModel.js, js/models/NavigationModel.js, js/navigation.js, js/views/NavigationButtonView.js, and js/views/navigationView.js. Documents include controller bootstrap behaviour, view lifecycle (initialize, template, changed, triggerEvent, remove), button management (add/get/remove, sorting, injected button handling), and usage examples. These changes improve code discoverability and clarify expected behaviour; no functional logic changes were introduced.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #855
Update
navigation.js— Added@file/@moduleheader and documentedaddNavigationBar()with@fires navigation:initializemodels/NavigationModel.js— Added@file/@moduleheader and@classdescribing layout config propertiesmodels/NavigationButtonModel.js— Added@file/@moduleheader and@classdescribing button config propertiesviews/navigationView.js— Added@file/@moduleheader with usage example; documentedbuttons,start(),sortNavigationButtons(),hideNavigationButton(),showNavigationButton(),addButton(),getButton(), andremoveButton()views/NavigationButtonView.js— Added@file/@moduleheader; documentedinitialize(),static get template,changed(),triggerEvent()with@firestags for all five built-in navigation events, andremove()Testing